home *** CD-ROM | disk | FTP | other *** search
/ BCI NET 2 / BCI NET 2.iso / archives / telecomm / ums / flow.lha / Flow / Flow.dok < prev    next >
Encoding:
Text File  |  1995-02-08  |  10.3 KB  |  302 lines
  1.  
  2.  
  3.                    ##### #     ##### #   #
  4.                    #     #     #   # #   #
  5.                    ###   #     #   # # # #
  6.                    #     #     #   # # # #
  7.                    #     ##### ##### #####  V1.11 (28.08.94)
  8.  
  9.  
  10.  
  11.  English                                  Some words...
  12.  
  13.  Was ist Flow ?                           Wer braucht Flow?
  14.  
  15.  Copyright                                Der ganze rechtliche Kram!
  16.  
  17.  Autor                                    Wie erreiche ich den Autor und
  18.                                             wo gibts die neueste Version?
  19.  Was wird benötigt ?                      Ohne das läuft nix!
  20.  
  21.  Installation                             Schnell passiert :)
  22.  
  23.  Synopsis                                 Welche Kommandos versteht Flow?
  24.  
  25.  Besonderheiten                           Was es sonst noch zu sagen gibt
  26.  
  27.  History                                  Was bisher passierte...
  28.  
  29.  
  30.  
  31.  
  32.  Sorry there is no English documentation yet... But if you would like
  33.  to see one included in this package just write one and send it to
  34.  me. :)
  35.  
  36.  
  37.    Background
  38.  
  39.  Im Fido ist es üblich, daß Mails als Fließtext geschrieben werden. D.h.
  40.  es wird nur nach jedem Absatz ein LF eingefügt anstatt wie im Editor
  41.  nach jeder Zeile. Die Mail wird erst bei der Darstellung entsprechen
  42.  umgebrochen. Dies dient dazu, daß Mails bei Leuten, die einen breiteren
  43.  Screen haben nicht am linken Rand kleben, sondern die ganze Breite des
  44.  Screens ausfüllen.
  45.  
  46.    Wieso Flow ?
  47.  
  48.  IntuiNews übernimmt die im Editor geschriebenen Mails 1:1 vom Editor.
  49.  Flow wird in einem Script nach dem Editor aufgerufen und wandelt die
  50.  Mail in Fließtext um.
  51.  
  52.  
  53.    Rechtliches:
  54.  
  55.  Flow ist Public Domain! D.h. jeder kann damit machen, was er will.
  56.  Jeder darf den Code verbessern/verändern oder Teile oder den ganzen
  57.  Code in eigene Projekte übernehmen. Ich wäre allerdings dankbar, wenn
  58.  man mir über etwaige Verbesserungen/Korrekturen bescheid geben würde,
  59.  damit ich sie in Flow einbauen kann.
  60.  
  61.  Ich übernehme keine Verantwortung für irgendwelche Schäden jeglicher
  62.  Art, die durch die Benutzung von Flow entstehen könnten. Wer es also
  63.  schafft sich mit Flow irgendetwas zu schrotten ist selbst Schuld!
  64.  
  65.  
  66.    BUG-Reports & Vorschläge bitte an eine der folgenden Adressen:
  67.  
  68.  Snail Mail: Klaus Wissmann
  69.              Eberhardtstraße 68
  70.              89073 Ulm
  71.  
  72.  Voice:      0731-23736
  73.  FAX..:      0731-9217965
  74.  
  75.  e-mail..: kwissmann@hydra.informatik.uni-ulm.de
  76.  FIDO....: Klaus Wissmann@2:2487/8001.37
  77.  
  78.  
  79.  Bei Bug-Reports bitte immer das Erstellungsdatum der benutzten Version
  80.  angeben. Dieses kann mit
  81.  
  82.    Version Flow full
  83.  
  84.  ausgegeben werden.
  85.  
  86.  
  87.  Einen schönen Dank an Norbert Bendl und Stephan Neumeister fürs
  88.  Betatesten!
  89.  
  90.  Die aktuelle Version von Flow gibts unter dem Namen "Flow.lha" im
  91.  Aminet und in den folgenden Mailboxen:
  92.  
  93.     Jugglers Inn (FIDO: 2:2487/9533)
  94.     AYN (FIDO: 2:2487/8001)
  95.     Galaxy (Brett: Support-Area/UMS-Support, Tel.: 07308/5890)
  96.  
  97.  
  98.  Was wird mindestens benötigt:
  99.  
  100.    * Kickstart 2.04
  101.  
  102.    * IntuiNews 1.2 von Markus Stipp & Matthias Scheler
  103.  
  104.       - DER Newsreader für UMS
  105.  
  106.  und natürlich
  107.  
  108.    * UMS 10.8 von Martin Horneffer
  109.  
  110.       - das Universal Message System
  111.  
  112.  
  113.    Installation
  114.  
  115.  1. Das Script
  116.  
  117.  Zuerst erstellt man sich folgendes Script und speichert es z.B. als
  118.  "Flow.script" in UMS/S ab:
  119.  
  120.  --- cut ---
  121.  .key MAIL
  122.  Flow <MAIL> ZL OFF
  123.  MeinEditor <MAIL>
  124.  Flow <MAIL> ZL CHKKEYWORDS
  125.  --- cut ---
  126.  
  127.  Für MeinEditor muß natürlich der verwendete Editor eingetragen werden
  128.  und ZL ersetzt man durch die im Editor eingestellte Zeilenlänge. In der
  129.  vierten Zeile kann man ggf. noch andere Optionen angeben.
  130.  
  131.  Kleine Erklärung zum Script: Der zweite Aufruf von Flow macht die
  132.  eigentliche Arbeit, nämlich die Umwandlung des Textes in Fließtext. Der
  133.  erste Aufruf von Flow ist dazu da, falls bereits geschriebene Mails
  134.  nochmal editiert werden sollen, diese wieder auf das ursprünglich
  135.  Format zurückzubringen.
  136.  Für weiter Erläuterungen zur Syntax von Flow siehe Synopsis.
  137.  
  138.  2. Änderungen an der ums.config
  139.  
  140.  Bezieht man nur Fido (oder ausschließlich FTN-kompatible Netze), dann
  141.  reicht folgende Änderung in der ums.config aus:
  142.  
  143.    IntuiNews.Editor = "UMS/S/Flow.Script"
  144.  
  145.  Liest man mit UMS auch in anderen Netzen mit, in denen Fließtext
  146.  unerwünscht ist (wie z.B. Usenet oder Z-Netz), so wird die Sache
  147.  komplizierter:
  148.  
  149.  Für Echomail muß man folgendes ändern:
  150.  
  151.    IntuiNews.Editor.fidonet = "UMS/S/Flow.script"
  152.  
  153.  Für die Netmails sollte man sich in diesem Fall einen eigenen Folder
  154.  fürs FIDO-Net anlegen. Dann ergänzt man seine ums.config noch mit
  155.  folgender Zeile:
  156.  
  157.    IntuiNews.Editor.mail.fidonet = "UMS/S/Flow.script"
  158.  
  159.  In diesem Fall müsste der Folder fürs Fido den Namen "fidonet" haben.
  160.  
  161.  
  162.    Synopsis:
  163.  
  164.  Flow MAIL/A,LENGTH/N,ON/S,OFF/S,AUTO/S,MIN=MINLENGTH/N,NOUUCHK/S,
  165.          CHK=CHKKEYWORDS/S,SKP=SKIPWORD/K,END=ENDWORD/K,VAR/K
  166.  
  167.  MAIL:        Name der Mail, die bearbeitet werden soll.
  168.  LENGTH:      Anzahl der Spalten mit der die Mail geschrieben wurde.
  169.               Fängt der benutzte Editor bei Spalte 1 an zu zählen, kann
  170.               man für LENGTH den Wert des rechten Randes angeben,
  171.               ansonsten muß man entsprechend korrigieren.
  172.               Ist OFF angegeben, muß die Länge auf jedenfall angegeben
  173.               werden. Wird reflowt, muß entweder LENGTH angegeben werden,
  174.               oder der AUTO-Modus eingeschaltet sein.
  175.  ON:          Die Mail wird in Fließtextumgewandelt (reflowt). Das ist
  176.               die Default-Einstellung.
  177.  OFF:         Die Mail wird auf die angegebene Zeilenlänge umgebrochen.
  178.  
  179.  Die folgenden Argumente sind nur von Bedeutung, falls eine Mail reflowt
  180.  wird.
  181.  
  182.  AUTO:        Flow versucht selbständig die Zeilenlänge der Mail zu
  183.               erkennen. Vorsicht: Es ist Flow nicht immer möglich, die
  184.               korrekte Zeilenlänge zu erkennen. Es ist auf jedenfall
  185.               sicherer die Länge mittels LENGTH direkt anzugeben.
  186.  MINLENGTH:   Gibt im AUTO-Modus die minimale Zeilenlänge
  187.               (Default: 30) an, bei der reflowt wird. Ist die von Flow
  188.               ermittelte Zeilenlänge kleiner als der Angegebene Wert
  189.               wird die gesammte Mail nicht verändert. Dies ist dazu da,
  190.               daß z.B. Mails an den AreaFix nicht reflowt werden.
  191.  NOUUCHK:     Kein Check auf UUcodierte Files im Text
  192.  CHKKEYWORDS: Schaltet die Kontrolle auf die beiden folgenden Stichwörter
  193.               im Text ein.
  194.  SKIPWORD:    Wird das angegebene Wort (Default: "<SKIP>") im Text
  195.               gefunden, so wird der Text bis zu
  196.  ENDWORD:     (Default "<END>") übersprungen und nicht verändert.
  197.  VAR:         Der Name der Environment-Variable, die vor dem Reflow
  198.               überprüft wird (Default: REFLOW).
  199.  
  200.  
  201.  
  202.    Reflow abschalten
  203.  
  204.  Bei bestimmten Texten ist es nicht wünschenswert, das sie verändert
  205.  werden. Zum Beispiel bei Tabellen, da diese unter Umständen danach
  206.  nicht mehr richtig lesbar wären. Deshalb lassen sich bestimmte
  207.  Textstellen vom Reflow ausschließen. Dazu dienen zwei Stichwörter
  208.  (Default: "<SKIP>" und "<END>"). Diese können aber in der Kommandozeile
  209.  auch geändert werden.
  210.  
  211.  Will man, daß eine bestimmte Textpassage nicht verändert wird, muß die
  212.  Mail etwa folgendermaßen aussehen:
  213.  
  214.  --- cut ---
  215.  blafasel
  216.  blubber blubber
  217.  <SKIP>
  218.  Dieser Teil der Mail wird nicht verändert...
  219.  <END>
  220.  Ab hier läuft alles wieder ganz normal...
  221.  --- cut ---
  222.  
  223.  Die beiden Stichworte MÜSSEN dabei allein und am Anfang einer Zeile
  224.  stehen, sonst werden sie nicht erkannt! Außerdem muß beim Aufruf von
  225.  Flow CHKKEYWORDS angegeben werden, sonst prüft Flow nicht, ob die
  226.  Stichworte im Text vorkommen. Die beiden Stichworte werden von Flow
  227.  beim bearbeiten der Mail entfernt.
  228.  
  229.    Environment-Variable
  230.  
  231.  Flow testet beim reflowen die globale Environment-Variable REFLOW (es
  232.  kann mit VAR auch eine andere Variable angegeben werden). Ist diese auf
  233.  False gesetzt, verändert Flow den angegebenen Text nicht. Dies kann
  234.  dazu verwendet werden, daß die Variable aus dem Editor heraus (z.B.
  235.  mittels eines ARexx Scripts) gesetzt werden kann, um direkt von Editor
  236.  aus den Reflow komplett abzuschalten.
  237.  
  238.  Hat Flow die Variable gefunden, und ist sie auf False gesetzt, so wird
  239.  sie gelöscht. Sie muß also bei jeder Mail, die nicht reflowt werden
  240.  soll neu gesetzt werden.
  241.  
  242.  Diesem Packet liegt ein Beispiel-Script für den GoldED bei. Die
  243.  Installation geht folgendermassen: Man erzeugt sich einen neuen
  244.  Menüpunkt namens "Kein Reflow" und belegt in mit dem beiliegenden
  245.  ARexx-Script. Danach wählt man bei "anzeigen" noch "USER1" aus. Fertig!
  246.  Will man, daß eine Mail nicht verändert wird wählt man einfach diesen
  247.  Menüpunkt an.
  248.  
  249.    UUcodierte Sachen
  250.  
  251.  Flow prüft, ob die Mail UUcodierte Files enthällt und verändert diese
  252.  nicht, sondern setzt den Reflow danach fort. Es ist also nicht nötig
  253.  UUcodierte Files mit <SKIP> und <END> einzuschließen.
  254.  Dieses Verhalten kann durch angabe von NOUUCHK in der Kommandozeile
  255.  abgeschaltet werden.
  256.  
  257.    Andere Anwendungsgebiete:
  258.  
  259.  Flow kann noch mehr, als nur Mails reflowen. Nur so als Beispiel: Ich
  260.  schreibe gerade nen Text mit meinem Editor. Zum Schluß bemerke ich, daß
  261.  ich ihn mit einer Breite von 98 Zeichen geschrieben habe, obwohl ich
  262.  ihn mit 79 haben wollte. Kein Problem:
  263.  
  264.    Flow <Text> 98 on
  265.    Flow <Text> 79 off
  266.  
  267.  Fertig ...
  268.  
  269.  
  270.    History:
  271.  
  272.  V1.0 (18.05.94)
  273.  
  274.    * erste Release!
  275.  
  276.  V1.1 (18.07.94)
  277.  
  278.    * Flow erkennt UUencodete Files innerhalb einer Mail selbständig und
  279.      verändert diese nicht
  280.  
  281.    * Optional versucht Flow die Zeilenlänge der Mail automatisch
  282.      herauszufinden
  283.  
  284.    * Error-Checks und Behandlung von zu langen Zeilen/Wörtern wurden verbessert
  285.  
  286.    * Der Name der zu überprüfenden Environment-Variable kann in der
  287.      Kommandozeile angegeben werden
  288.  
  289.  V1.11 (28.08.94)
  290.  
  291.    * Im Auto-Modus wird die Mail nur noch reflowt, falls die
  292.      festgestellte Zeilenlänge größer als MINLENGTH ist.
  293.  
  294.  
  295.  ToDo + Known Bugs
  296.  
  297.    * well...
  298.  
  299.  
  300.  Vorschläge bzw. Bug-Reports bitte an mich...
  301.  
  302.